GetMatTemp {Tendon Object}

GetMatTemp

Syntax

SapObject.SapModel.TendonObj.GetMatTemp

VB6 Procedure

Function GetMatTemp(ByVal Name As String, ByRef Temp As Double, ByRef PatternName As String) As Long

Parameters

Name

The name of an existing tendon object.

Temp

This is the material temperature value assigned to the tendon object. [T]

PatternName

This is blank or the name of a defined joint pattern. If it is blank, the material temperature for the tendon object is uniform along the object at the value specified by Temp.

If PatternName is the name of a defined joint pattern, the material temperature for the tendon object may vary from one end to the other. The material temperature at each end of the object is equal to the specified temperature multiplied by the pattern value at the joint at the end of the tendon object.

Remarks

This function retrieves the material temperature assignments to tendon objects.

The function returns zero if the material temperature assignments are successfully retrieved, otherwise it returns a nonzero value.

VBA Example

Sub GetTendonMatTemp()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Temp As Double

Dim PatternName As String

Dim Name As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'add tendon object by points

ret = SapModel.TendonObj.AddByPoint("3", "9", Name)

'assign material temperature

ret = SapModel.TendonObj.SetMatTemp("ALL", 50, , Group)

'get material temperature

ret = SapModel.TendonObj.GetMatTemp(Name, Temp, PatternName)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also

SetMatTemp